Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

services/horizon: Add clarity to error when setting BUCKET_DIR_PATH with captive core #4736

Merged
merged 1 commit into from
Jan 10, 2023
Merged

services/horizon: Add clarity to error when setting BUCKET_DIR_PATH with captive core #4736

merged 1 commit into from
Jan 10, 2023

Conversation

mollykarcher
Copy link
Contributor

PR Checklist

PR Structure

  • This PR has reasonably narrow scope (if not, break it down into smaller PRs).
  • This PR avoids mixing refactoring changes with feature changes (split into two PRs
    otherwise).
  • This PR's title starts with name of package that is most changed in the PR, ex.
    services/friendbot, or all or doc if the changes are broad or impact many
    packages.

Thoroughness

  • This PR adds tests for the most critical parts of the new functionality or fixes.
  • I've updated any docs (developer docs, .md
    files, etc... affected by this change). Take a look in the docs folder for a given service,
    like this one.

Release planning

  • I've updated the relevant CHANGELOG (here for Horizon) if
    needed with deprecations, added features, breaking changes, and DB schema changes.
  • I've decided if this PR requires a new major/minor version according to
    semver, or if it's mainly a patch change. The PR is targeted at the next
    release branch if it's not a patch change.

What

Changing the error message returned when BUCKET_DIR_PATH is set when using captive core, just so that it's clear what corrective action needs to be taken.

Why

Partner engineering raised this when working through an issue with Kraken, the error message returned is confusing and doesn't indicate to the end-user the best way to resolve

Invalid captive core toml file could not unmarshal captive core toml: setting BUCKET_DIR_PATH is disallowed, it can cause clashes between instances

@mollykarcher mollykarcher linked an issue Jan 9, 2023 that may be closed by this pull request
When using captive core, bucket dir path error should be more explicit #4732
Closed
leighmcculloch
leighmcculloch approved these changes Jan 9, 2023
View reviewed changes
Copy link
Member

@leighmcculloch leighmcculloch left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

👏🏻

@mollykarcher mollykarcher merged commit 7844155 into stellar:master Jan 10, 2023
@mollykarcher mollykarcher deleted the molly/master/4732 branch January 10, 2023 20:59
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@leighmcculloch leighmcculloch leighmcculloch approved these changes

Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.

When using captive core, bucket dir path error should be more explicit
2 participants
@mollykarcher @leighmcculloch